home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / games / nhak_src.zip / RANDOM.C < prev    next >
C/C++ Source or Header  |  1993-03-16  |  14KB  |  382 lines
  1. /*
  2.  * Copyright (c) 1983 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms are permitted
  6.  * provided that the above copyright notice and this paragraph are
  7.  * duplicated in all such forms and that any documentation,
  8.  * advertising materials, and other materials related to such
  9.  * distribution and use acknowledge that the software was developed
  10.  * by the University of California, Berkeley.  The name of the
  11.  * University may not be used to endorse or promote products derived
  12.  * from this software without specific prior written permission.
  13.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16.  */
  17.  
  18. /* Several minor changes were made for the NetHack distribution to satisfy
  19.  * non-BSD compilers (by definition BSD compilers do not need to compile
  20.  * this file for NetHack).  These changes consisted of:
  21.  *    - changing the sccsid conditions to nested ifdefs from defined()s
  22.  *    to accommodate stupid preprocessors
  23.  *    - giving srandom() type void instead of allowing it to default to int
  24.  *    - making the first return in initstate() return a value consistent
  25.  *    with its type (instead of no value)
  26.  *    - ANSI function prototyping in extern.h - therefore include hack.h
  27.  *    instead of stdio.h and remove separate declaration of random() from
  28.  *    the beginning of function srandom
  29.  */
  30.  
  31. #ifdef LIBC_SCCS
  32. # ifndef lint
  33. static char sccsid[] = "@(#)random.c    5.5 (Berkeley) 7/6/88";
  34. # endif
  35. #endif /* LIBC_SCCS and not lint */
  36.  
  37. #include "hack.h"
  38.  
  39. /*
  40.  * random.c:
  41.  * An improved random number generation package.  In addition to the standard
  42.  * rand()/srand() like interface, this package also has a special state info
  43.  * interface.  The initstate() routine is called with a seed, an array of
  44.  * bytes, and a count of how many bytes are being passed in; this array is then
  45.  * initialized to contain information for random number generation with that
  46.  * much state information.  Good sizes for the amount of state information are
  47.  * 32, 64, 128, and 256 bytes.  The state can be switched by calling the
  48.  * setstate() routine with the same array as was initiallized with initstate().
  49.  * By default, the package runs with 128 bytes of state information and
  50.  * generates far better random numbers than a linear congruential generator.
  51.  * If the amount of state information is less than 32 bytes, a simple linear
  52.  * congruential R.N.G. is used.
  53.  * Internally, the state information is treated as an array of longs; the
  54.  * zeroeth element of the array is the type of R.N.G. being used (small
  55.  * integer); the remainder of the array is the state information for the
  56.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  57.  * state information, which will allow a degree seven polynomial.  (Note: the 
  58.  * zeroeth word of state information also has some other information stored
  59.  * in it -- see setstate() for details).
  60.  * The random number generation technique is a linear feedback shift register
  61.  * approach, employing trinomials (since there are fewer terms to sum up that
  62.  * way).  In this approach, the least significant bit of all the numbers in
  63.  * the state table will act as a linear feedback shift register, and will have
  64.  * period 2^deg - 1 (where deg is the degree of the polynomial being used,
  65.  * assuming that the polynomial is irreducible and primitive).  The higher
  66.  * order bits will have longer periods, since their values are also influenced
  67.  * by pseudo-random carries out of the lower bits.  The total period of the
  68.  * generator is approximately deg*(2**deg - 1); thus doubling the amount of
  69.  * state information has a vast influence on the period of the generator.
  70.  * Note: the deg*(2**deg - 1) is an approximation only good for large deg,
  71.  * when the period of the shift register is the dominant factor.  With deg
  72.  * equal to seven, the period is actually much longer than the 7*(2**7 - 1)
  73.  * predicted by this formula.
  74.  */
  75.  
  76.  
  77.  
  78. /*
  79.  * For each of the currently supported random number generators, we have a
  80.  * break value on the amount of state information (you need at least this
  81.  * many bytes of state info to support this random number generator), a degree
  82.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  83.  * the separation between the two lower order coefficients of the trinomial.
  84.  */
  85.  
  86. #define        TYPE_0        0        /* linear congruential */
  87. #define        BREAK_0        8
  88. #define        DEG_0        0
  89. #define        SEP_0        0
  90.  
  91. #define        TYPE_1        1        /* x**7 + x**3 + 1 */
  92. #define        BREAK_1        32
  93. #define        DEG_1        7
  94. #define        SEP_1        3
  95.  
  96. #define        TYPE_2        2        /* x**15 + x + 1 */
  97. #define        BREAK_2        64
  98. #define        DEG_2        15
  99. #define        SEP_2        1
  100.  
  101. #define        TYPE_3        3        /* x**31 + x**3 + 1 */
  102. #define        BREAK_3        128
  103. #define        DEG_3        31
  104. #define        SEP_3        3
  105.  
  106. #define        TYPE_4        4        /* x**63 + x + 1 */
  107. #define        BREAK_4        256
  108. #define        DEG_4        63
  109. #define        SEP_4        1
  110.  
  111.  
  112. /*
  113.  * Array versions of the above information to make code run faster -- relies
  114.  * on fact that TYPE_i == i.
  115.  */
  116.  
  117. #define        MAX_TYPES    5        /* max number of types above */
  118.  
  119. static  int        degrees[ MAX_TYPES ]    = { DEG_0, DEG_1, DEG_2,
  120.                                 DEG_3, DEG_4 };
  121.  
  122. static  int        seps[ MAX_TYPES ]    = { SEP_0, SEP_1, SEP_2,
  123.                                 SEP_3, SEP_4 };
  124.  
  125.  
  126.  
  127. /*
  128.  * Initially, everything is set up as if from :
  129.  *        initstate( 1, &randtbl, 128 );
  130.  * Note that this initialization takes advantage of the fact that srandom()
  131.  * advances the front and rear pointers 10*rand_deg times, and hence the
  132.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  133.  * element of the state information, which contains info about the current
  134.  * position of the rear pointer is just
  135.  *    MAX_TYPES*(rptr - state) + TYPE_3 == TYPE_3.
  136.  */
  137.  
  138. static  long        randtbl[ DEG_3 + 1 ]    = { TYPE_3,
  139.                 0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342, 
  140.                 0xde3b81e0, 0xdf0a6fb5, 0xf103bc02, 0x48f340fb, 
  141.                 0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd, 
  142.                 0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86, 
  143.                 0xda672e2a, 0x1588ca88, 0xe369735d, 0x904f35f7, 
  144.                 0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc, 
  145.                 0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b, 
  146.                     0xf5ad9d0e, 0x8999220b, 0x27fb47b9 };
  147.  
  148. /*
  149.  * fptr and rptr are two pointers into the state info, a front and a rear
  150.  * pointer.  These two pointers are always rand_sep places aparts, as they cycle
  151.  * cyclically through the state information.  (Yes, this does mean we could get
  152.  * away with just one pointer, but the code for random() is more efficient this
  153.  * way).  The pointers are left positioned as they would be from the call
  154.  *            initstate( 1, randtbl, 128 )
  155.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  156.  * in the initialization of randtbl) because the state table pointer is set
  157.  * to point to randtbl[1] (as explained below).
  158.  */
  159.  
  160. static  long        *fptr            = &randtbl[ SEP_3 + 1 ];
  161. static  long        *rptr            = &randtbl[ 1 ];
  162.  
  163.  
  164.  
  165. /*
  166.  * The following things are the pointer to the state information table,
  167.  * the type of the current generator, the degree of the current polynomial
  168.  * being used, and the separation between the two pointers.
  169.  * Note that for efficiency of random(), we remember the first location of
  170.  * the state information, not the zeroeth.  Hence it is valid to access
  171.  * state[-1], which is used to store the type of the R.N.G.
  172.  * Also, we remember the last location, since this is more efficient than
  173.  * indexing every time to find the address of the last element to see if
  174.  * the front and rear pointers have wrapped.
  175.  */
  176.  
  177. static  long        *state            = &randtbl[ 1 ];
  178.  
  179. static  int        rand_type        = TYPE_3;
  180. static  int        rand_deg        = DEG_3;
  181. static  int        rand_sep        = SEP_3;
  182.  
  183. static  long        *end_ptr        = &randtbl[ DEG_3 + 1 ];
  184.  
  185.  
  186.  
  187. /*
  188.  * srandom:
  189.  * Initialize the random number generator based on the given seed.  If the
  190.  * type is the trivial no-state-information type, just remember the seed.
  191.  * Otherwise, initializes state[] based on the given "seed" via a linear
  192.  * congruential generator.  Then, the pointers are set to known locations
  193.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  194.  * information a given number of times to get rid of any initial dependencies
  195.  * introduced by the L.C.R.N.G.
  196.  * Note that the initialization of randtbl[] for default usage relies on
  197.  * values produced by this routine.
  198.  */
  199.  
  200. void
  201. srandom( x )
  202.  
  203.     unsigned        x;
  204. {
  205.         register  int        i, j;
  206.  
  207.     if(  rand_type  ==  TYPE_0  )  {
  208.         state[ 0 ] = x;
  209.     }
  210.     else  {
  211.         j = 1;
  212.         state[ 0 ] = x;
  213.         for( i = 1; i < rand_deg; i++ )  {
  214.         state[i] = 1103515245*state[i - 1] + 12345;
  215.         }
  216.         fptr = &state[ rand_sep ];
  217.         rptr = &state[ 0 ];
  218.         for( i = 0; i < 10*rand_deg; i++ )  random();
  219.     }
  220. }
  221.  
  222.  
  223.  
  224. /*
  225.  * initstate:
  226.  * Initialize the state information in the given array of n bytes for
  227.  * future random number generation.  Based on the number of bytes we
  228.  * are given, and the break values for the different R.N.G.'s, we choose
  229.  * the best (largest) one we can and set things up for it.  srandom() is
  230.  * then called to initialize the state information.
  231.  * Note that on return from srandom(), we set state[-1] to be the type
  232.  * multiplexed with the current value of the rear pointer; this is so
  233.  * successive calls to initstate() won't lose this information and will
  234.  * be able to restart with setstate().
  235.  * Note: the first thing we do is save the current state, if any, just like
  236.  * setstate() so that it doesn't matter when initstate is called.
  237.  * Returns a pointer to the old state.
  238.  */
  239.  
  240. char  *
  241. initstate( seed, arg_state, n )
  242.  
  243.     unsigned        seed;            /* seed for R. N. G. */
  244.     char        *arg_state;        /* pointer to state array */
  245.     int            n;            /* # bytes of state info */
  246. {
  247.     register  char        *ostate        = (char *)( &state[ -1 ] );
  248.  
  249.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  250.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  251.     if(  n  <  BREAK_1  )  {
  252.         if(  n  <  BREAK_0  )  {
  253.         fprintf( stderr, "initstate: not enough state (%d bytes) with which to do jack; ignored.\n", n );
  254.         return (char *)0;
  255.         }
  256.         rand_type = TYPE_0;
  257.         rand_deg = DEG_0;
  258.         rand_sep = SEP_0;
  259.     }
  260.     else  {
  261.         if(  n  <  BREAK_2  )  {
  262.         rand_type = TYPE_1;
  263.         rand_deg = DEG_1;
  264.         rand_sep = SEP_1;
  265.         }
  266.         else  {
  267.         if(  n  <  BREAK_3  )  {
  268.             rand_type = TYPE_2;
  269.             rand_deg = DEG_2;
  270.             rand_sep = SEP_2;
  271.         }
  272.         else  {
  273.             if(  n  <  BREAK_4  )  {
  274.             rand_type = TYPE_3;
  275.             rand_deg = DEG_3;
  276.             rand_sep = SEP_3;
  277.             }
  278.             else  {
  279.             rand_type = TYPE_4;
  280.             rand_deg = DEG_4;
  281.             rand_sep = SEP_4;
  282.             }
  283.         }
  284.         }
  285.     }
  286.     state = &(  ( (long *)arg_state )[1]  );    /* first location */
  287.     end_ptr = &state[ rand_deg ];    /* must set end_ptr before srandom */
  288.     srandom( seed );
  289.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  290.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  291.     return( ostate );
  292. }
  293.  
  294.  
  295.  
  296. /*
  297.  * setstate:
  298.  * Restore the state from the given state array.
  299.  * Note: it is important that we also remember the locations of the pointers
  300.  * in the current state information, and restore the locations of the pointers
  301.  * from the old state information.  This is done by multiplexing the pointer
  302.  * location into the zeroeth word of the state information.
  303.  * Note that due to the order in which things are done, it is OK to call
  304.  * setstate() with the same state as the current state.
  305.  * Returns a pointer to the old state information.
  306.  */
  307.  
  308. char  *
  309. setstate( arg_state )
  310.  
  311.     char        *arg_state;
  312. {
  313.     register  long        *new_state    = (long *)arg_state;
  314.     register  int        type        = new_state[0]%MAX_TYPES;
  315.     register  int        rear        = new_state[0]/MAX_TYPES;
  316.     char            *ostate        = (char *)( &state[ -1 ] );
  317.  
  318.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  319.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  320.     switch(  type  )  {
  321.         case  TYPE_0:
  322.         case  TYPE_1:
  323.         case  TYPE_2:
  324.         case  TYPE_3:
  325.         case  TYPE_4:
  326.         rand_type = type;
  327.         rand_deg = degrees[ type ];
  328.         rand_sep = seps[ type ];
  329.         break;
  330.  
  331.         default:
  332.         fprintf( stderr, "setstate: state info has been munged; not changed.\n" );
  333.     }
  334.     state = &new_state[ 1 ];
  335.     if(  rand_type  !=  TYPE_0  )  {
  336.         rptr = &state[ rear ];
  337.         fptr = &state[ (rear + rand_sep)%rand_deg ];
  338.     }
  339.     end_ptr = &state[ rand_deg ];        /* set end_ptr too */
  340.     return( ostate );
  341. }
  342.  
  343.  
  344.  
  345. /*
  346.  * random:
  347.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  348.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
  349.  * same in all ther other cases due to all the global variables that have been
  350.  * set up.  The basic operation is to add the number at the rear pointer into
  351.  * the one at the front pointer.  Then both pointers are advanced to the next
  352.  * location cyclically in the table.  The value returned is the sum generated,
  353.  * reduced to 31 bits by throwing away the "least random" low bit.
  354.  * Note: the code takes advantage of the fact that both the front and
  355.  * rear pointers can't wrap on the same call by not testing the rear
  356.  * pointer if the front one has wrapped.
  357.  * Returns a 31-bit random number.
  358.  */
  359.  
  360. long
  361. random()
  362. {
  363.     long        i;
  364.     
  365.     if(  rand_type  ==  TYPE_0  )  {
  366.         i = state[0] = ( state[0]*1103515245 + 12345 )&0x7fffffff;
  367.     }
  368.     else  {
  369.         *fptr += *rptr;
  370.         i = (*fptr >> 1)&0x7fffffff;    /* chucking least random bit */
  371.         if(  ++fptr  >=  end_ptr  )  {
  372.         fptr = state;
  373.         ++rptr;
  374.         }
  375.         else  {
  376.         if(  ++rptr  >=  end_ptr  )  rptr = state;
  377.         }
  378.     }
  379.     return( i );
  380. }
  381.  
  382.